Description

The goal was to update the architecture to reflect the new features added in the past. Also, since we want to use the C4 method now, it was the right time to rewrite this page.

Generated example

When I run poetry run mkdocs serve, I get the following now:

What I ran into

• The diagram that we sketched beforehand was too big to use with Mermaid, so I decided to split them up. This means that the intended Transformer Componentdiagram is not added, because that is a level to deep.
• I also opted to include a "generic" cyclic optimiser, to also show another possible implementation and further differentiate between the use of a person and another program. This can be removed if deemed necessary.
• That would mean it would be a "C4: Code" level now, and we need to look into generating that diagram automatically. I think that is a good decision, since that level does seem quite easily mutated and changed, and we do not want to struggle with Mermaid of keeping up with that level of code.
• Mermaid is quite in its infancy with C4 diagrams, resulting in some unreadable and strangely formatted text. I would argue that this is not really that big of a deal for now, but should this not change in the next couple of months I would suggesting moving to a different method. The reason I'd still want to use Mermaid is 1) we have a system in place now, and 2) you can still read it from code, which is my most important reason.
• I do not have time to perfect this in the coming week. So if this is "good enough", I'd argue let's ship it, or we'd have to wait for a bit until I return from holidays.
• I added an ignore for line length, because I could not find a method to break the lines in the editor.